Readme #36
Readme #36
Conversation
AveryVine
left a comment
AveryVine
left a comment
There was a problem hiding this comment.
Looks good! Lots of small comments, but should be easy enough to fix. Thanks again for doing this.
| ## Project summary | ||
|
|
||
| This project is the mirror version of the iOS Science Student Success Centre app, for Android! It allows students to view all of the events that are shown on the SSSC's website and quickly access the SSSC's resources page. | ||
| Event data for both the Android and iOS apps are retrieved using a GET request to the SSSC Server (linked above) using the `/events` endpoint, to ensure their data is sychronized. |
There was a problem hiding this comment.
Can you add the same sort of details for /mentors and /features?
|
|
||
| ## Project summary | ||
|
|
||
| This project is the mirror version of the iOS Science Student Success Centre app, for Android! It allows students to view all of the events that are shown on the SSSC's website and quickly access the SSSC's resources page. |
There was a problem hiding this comment.
Can you mention the grade calculator and booking mentoring appointments?
| This project is the mirror version of the iOS Science Student Success Centre app, for Android! It allows students to view all of the events that are shown on the SSSC's website and quickly access the SSSC's resources page. | ||
| Event data for both the Android and iOS apps are retrieved using a GET request to the SSSC Server (linked above) using the `/events` endpoint, to ensure their data is sychronized. | ||
|
|
||
| ## Updates |
There was a problem hiding this comment.
Can we change this heading to Potential Update Ideas?
|
|
||
| ## Updates | ||
|
|
||
| (Refer to the ios app for the following features) |
There was a problem hiding this comment.
Can you link the iOS app repo here using a markdown link? Like this. (Also maybe proper capitalization of iOS!)
|
|
||
| ## Getting started | ||
|
|
||
| There are a few different steps you'll need to go through to work on the app. The first step should be to have Android Studio installed on your computer if you dont have it already. You can follow the download instrauction [here](https://developer.android.com/studio/install). |
There was a problem hiding this comment.
Watch spelling of "instructions"
|
|
||
| * Note make sure you have the keystore file(.jks) before you start this process * | ||
|
|
||
| 1. First step is to increment the versionCode and versionName attributes in the app level gradle file. |
There was a problem hiding this comment.
Can you explicitly put the filename here? Otherwise they might get the Gradle files confused
|
|
||
| ## Part 2: Creating a Release in the Play Console | ||
|
|
||
| Now that you have a signed app bundle you can go over to the Play Console site and setup the release. |
There was a problem hiding this comment.
Link the Play Console here?
|
|
||
| ## Next Steps | ||
| 1. Once you login you will see a list of published apps. Select the SSSC app(it should be the only one) ;) | ||
| 2. Navigate to Store Prescense -> Store Listing in the menu on the left. In the Store Listing you can modify the screenshots if needed and also edit the app description to included new features. (ONLY if neeeded) |
| 1. Once you login you will see a list of published apps. Select the SSSC app(it should be the only one) ;) | ||
| 2. Navigate to Store Prescense -> Store Listing in the menu on the left. In the Store Listing you can modify the screenshots if needed and also edit the app description to included new features. (ONLY if neeeded) | ||
| 3. Navigate to Release Management -> App Releases on the menu. | ||
| 4. In the Production section sleect "Manage" |
| 10. On the next screen hit "Rollout"! | ||
|
|
||
| This app is currently incomplete. The Events and Resources pages are completed, but the grades page is still under construction. | ||
| Awesome! You just published your update to the Play Store! It might take a few hours for the update to be seen on the Play store. |
There was a problem hiding this comment.
Can you add a section after this, like on the iOS app page, about being very careful when editing database-related stuff? We want to emphasize that they should be careful so students' grades don't disappear!
No description provided.